Hybris UX Api
GET productOrderById (TMF622)
GET
This Operation is used to Retrieve Order Details
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
https://[localhost]:[port]/ecom-ux/v1/PR/productOrder/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. Enum values: BS-Bahamas CO-Colombia CO1-Colombia Zona Franca CL-Chile CR-Costa Rica DO-Dominican Republic GT-Guatemala HN-Honduras JM-Jamaica PA-Panama PR-Puerto Rico SV-Salvador | Y |
| id | string | Need to provide valid customer product order id | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client-id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N It is Mandatory for business |
| channelId | string | Channel to business: Expected Value: "ECOM" | Y |
| lob | string | It defines the Line of Business . Expected value is FIXED | Y |
QueryParams
| name | value | description | required |
|---|---|---|---|
| accountId | string | customer account Unique Identifier | Mandatory for PA |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ] For CSG (LCPR Market)
Created - Resource created successfully, response body contains an entity corresponding to the requested resource.
{
"id": "1200043589071014",
"category": "S",
"completionDate": "",
"priority": "1",
"requestedCompletionDate": "2022-10-04T00:00:00Z",
"productOrderItem": [
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"state": "I",
"product": {
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"orderDate": "0001-01-01",
"realizingService": {
"id": "028002",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "RFIPT",
"name": "Iptv Box",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000001",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "RF6CB",
"name": "Connect Box",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000002",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "RJ43X",
"name": "40/4 Mb",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000003",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "RV7UL",
"name": "Ultimate",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000004",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "RW4US",
"name": "Pr-Us Unlim.",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000005",
"@type": "ServiceIdentifier"
},
"productCharacteristic": [
{
"name": "phoneNumber",
"value": {
"phoneNumber": "9395455910",
"isNative": "Y"
}
}
]
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "ZD10N",
"name": "Resdirlist",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000006",
"@type": "ServiceIdentifier"
},
"productCharacteristic": [
{
"name": "phoneNumber",
"value": {
"phoneNumber": "9395455910",
"isNative": "Y"
}
}
]
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "ZD107",
"name": "Res-Primary",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000007",
"@type": "ServiceIdentifier"
},
"productCharacteristic": [
{
"name": "phoneNumber",
"value": {
"phoneNumber": "9395455910",
"isNative": "Y"
}
}
]
}
},
{
"id": "R7U3I",
"name": "3P-Ui-30-Us",
"quantity": 1,
"product": {
"id": "ZY101",
"name": "Res Data A/O",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000008",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "0MINS",
"name": "B2C Install",
"quantity": 1,
"product": {
"id": "0MINS",
"name": "B2C Install",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000009",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "RYWFB",
"name": "Wow-Fi Basic",
"quantity": 1,
"product": {
"id": "RYWFB",
"name": "Wow-Fi Basic",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000010",
"@type": "ServiceIdentifier"
}
}
},
{
"id": "RZ020",
"name": "Ndvr 20Hrs",
"quantity": 1,
"product": {
"id": "RZ020",
"name": "Ndvr 20Hrs",
"orderDate": "0001-01-01",
"realizingService": {
"id": "000011",
"@type": "ServiceIdentifier"
}
}
}
],
"relatedParty": [
{
"id": "12345",
"role": "SalesRepresentative",
"@referredType": "Individual"
},
{
"role": "Customer",
"id": "1901504956721",
"name": "TEST ZT",
"@referredType": "Individual"
}
]
}[ 200 ] For PA Market
Created - Resource created successfully, response body contains an entity corresponding to the requested resource.
{
"id": "GD0017B",
"description": "This order has been outstanding for 0 minutes.Please see circulation profile for further detail.",
"completionDate":"2023-05-04T00:00:00.000-05:00",
"expectedCompletionDate": "2023-05-04T00:00:00.000-05:00",
"externalId": "",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"priority": "4",
"requestedCompletionDate":"2023-05-04T00:00:00.000-05:00",
"requestedStartDate": "2022-12-04T00:00:00.000-05:00",
"billingAccount": {
"id": "337867570000",
"name": "MR INSTALLATION TEST114"
},
"channel": [{
"id": "EH",
"role": "Used channel for order capture",
"name": "ECOMMERCE HYBRIS"
}],
"productOrderItem": [
{
"id": "1595",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "ADSL",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PDL"
},
{
"name": "servType",
"valueType": "string",
"value": "DS"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "10573688"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "35584645"
}
],
"itemPrice": {
"productOfferingPrice": {
"id": "1",
"@referredType": "priceVarCode"
}
},
"productSpecification": {
"id": "1595",
"name": "Internet FTTH 750 Mbps / 750 Mbps",
"description": "Internet FTTH 750 Mbps / 750 Mbps",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "DS2528760",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "1537",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "ADSL",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PME"
},
{
"name": "servType",
"valueType": "string",
"value": "DS"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "10573688"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "85572436"
}
],
"itemPrice": {
"productOfferingPrice": {
"id": "7",
"@referredType": "priceVarCode"
}
},
"productSpecification": {
"id": "1537",
"name": "Movil Mesh Wifi Exte desktop FTTH",
"description": "Movil Mesh Wifi Exte desktop FTTH",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "DS2528760",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "1538",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "ADSL",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "POH"
},
{
"name": "servType",
"valueType": "string",
"value": "DS"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "10573688"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "45633690"
}
],
"productSpecification": {
"id": "1538",
"name": "Gateway IP3442",
"description": "Gateway IP3442",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "DS2528760",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "1539",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "ADSL",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "POH"
},
{
"name": "servType",
"valueType": "string",
"value": "DS"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "10573688"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "75573476"
}
],
"productSpecification": {
"id": "1539",
"name": "ONT FG1100R",
"description": "ONT FG1100R",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "DS2528760",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "42000",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PTI"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "15615051"
}
],
"productSpecification": {
"id": "42000",
"name": "Serv. Asociado a TV +TV TotalIP",
"description": "Serv. Asociado a TV +TV TotalIP",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "40043",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PFB"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587834"
}
],
"itemPrice": {
"productOfferingPrice": {
"id": "1",
"@referredType": "priceVarCode"
}
},
"productSpecification": {
"id": "40043",
"name": "TV BasicoPlus IP HBOPack +TVTotal",
"description": "TV BasicoPlus IP HBOPack +TVTotal",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "41124",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PTP"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587835"
}
],
"productSpecification": {
"id": "41124",
"name": "Freeview 1",
"description": "Freeview 1",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "41125",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PTP"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587836"
}
],
"productSpecification": {
"id": "41125",
"name": "Freeview 2",
"description": "Freeview 2",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "41126",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PTP"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587837"
}
],
"productSpecification": {
"id": "41126",
"name": "Audiomusic TV Total",
"description": "Audiomusic TV Total",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "42060",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PST"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587838"
}
],
"productSpecification": {
"id": "42060",
"name": "Caja Next Gen. eSTREAM4k IP",
"description": "Caja Next Gen. eSTREAM4k IP",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "42060",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PST"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587839"
}
],
"productSpecification": {
"id": "42060",
"name": "Caja Next Gen. eSTREAM4k IP",
"description": "Caja Next Gen. eSTREAM4k IP",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
},
{
"id": "42114",
"quantity": 1,
"state": "completed",
"product": {
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"description": "+TV Digital HD",
"productCharacteristic": [
{
"name": "commandId",
"valueType": "string",
"value": "PFV"
},
{
"name": "servType",
"valueType": "string",
"value": "TI"
},
{
"name": "uniqueServId",
"valueType": "string",
"value": "50571548"
},
{
"name": "custProdNo",
"valueType": "string",
"value": "55587840"
}
],
"productSpecification": {
"id": "42114",
"name": "VOD +TV TotalIP",
"description": "VOD +TV TotalIP",
"orderDate": "2022-12-04T00:00:00.000-05:00",
"productSerialNumber": "TI502",
"startDate": "2022-12-04T00:00:00.000-05:00",
"terminationDate": "2022-12-04T00:00:00.000-05:00"
}
}
}
],
"orderCharacteristics": {
"siteCode": "FTTH",
"depttCode": "ASIFH"
},
"relatedParty": [{
"id": "70013",
"name": "eCOMMERCE ECOMMERCE",
"role": "e ECOMMERCE",
"@referredType": "Individual"
}],
"state": "completed",
"@type": "ProductOrder"
}Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400 ,
"message" : "The request is invalid or not properly formed.",
"description" : "The client sent too many requests and server is not able to serve them all at the moment"
}
]
}Category Expected Fields:
| Type | Description |
|---|---|
| M | Special request |
| S | Service order |
| T | Trouble call |